4.2.2.2 编辑用户-基于名称

可通过此接口在用户目录更新用户信息。

基本信息

请求地址：https://SDPC-IP:4433/api/v3/user/updateByName

请求方式：POST

请求头（Header）

点击查看

请求体（Body）

注意：对于参数 password，为了保障数据传输过程中（数据从浏览器/客户端到服务端的过程）密码数据的安全，强烈建议使用RSA算法对密码字段进行加密（将 pwdModel 参数设置为 "rsa"）。加密方式参考 6.2 附录-RSA加密方案。如果您不想对密码字段进行加密（不建议），可以不传 pwdModel 参数或者将 pwdModel 参数设置为 "clear"。

参数	中文名称	必须	类型	描述
directoryDomain	用户目录唯一标识	是	string	用户目录唯一标识，在控制台点击用户目录设置即可查看。本地用户目录的唯一标识为 `local`。外部用户目录示例：`custom01339`（唯一标识无需携带@）
name	用户名	是	string	示例： zhangsan 1001
group	所属组织架构	否	object	仅本地用户目录和自定义用户目录下用户支持修改所属组织架构。企业微信、钉钉、浙政钉、飞书、AD、OpenLDAP、IDTrust LDAP用户目录不支持修改所属组织架构。
├─ key	组织架构唯一标识	否	string	key 是指标识组织架构的对象，即通过什么方式（或值）来关联指定的组织架构。零信任提供了三种标识来定义组织架构，即 id/fullPath/externalId。存在 group 参数时，此参数必传。取值范围： `id`-组织架构id `fullPath`-组织架构全路径 `externalId`-组织架构外部id
├─ data	组织架构唯一标识对应值	否	string	data 是 key 值的结果，即若 key 的赋值是 fullPath，那么 data 对应的赋值就是组织架构全路径，如: /客服体系/专家中心/零信任专家组。若 key 的赋值是 externalId ，那么 data 就需要写组织架构的外部id值。存在 group 参数时，此参数必传。 key 与 data 的对应取值示例如下： `id`：1345c177-e4f6-11ee-835b-fefcfeefe529 `fullPath`：/客服体系/专家中心/零信任专家组 `externalId`：202cb962ac59075b964b07152d234b70
externalId	外部id	否	string	仅本地用户目录和自定义用户目录下的用户支持修改外部 id。示例：81dc9bdb52d04dc2
inheritGroup	是否继承组织架构的应用授权	否	number	取值范围： `1`-继承（默认） `0`-不继承
password	用户密码	否	string	仅本地用户目录下的用户支持修改密码
pwdModel	用户密码加密算法类型	否	string	建议使用 `rsa` 算法进行加密，加密方法见6.2 附录-RSA加密方案。取值范围： `clear`-明文（默认） `rsa`-非对称加密。
displayName	显示名	否	string	用户的显示名。在用户登录后，个人主页展示用户信息时将优先展示显示名，没有显示名时才展示用户名。示例：张三
description	描述信息	否	string	用户的描述信息。
status	启用状态	否	number	取值范围： `1`-启用（默认） `0`-禁用
phone	手机号	否	string	示例：13800000000
email	邮箱	否	string	示例：zhangsan@website.com
expiredTime	过期时间	否	string	支持毫秒级别的Unix时间戳，以及时间字符串格式如：2024-03-18 12:00:00。不传时默认永不过期。示例：时间戳：1710745688563 时间字符串：2024-03-18 12:00:00、2024/03/18 12:00:00
dataSource	用户数据来源	否	object	仅外部用户有此参数
├─ displayName	显示名来源	否	string	取值范围： `local`-从本地配置获取 `server`-从用户目录同步和从认证服务器获取
├─ description	描述来源	否	string	取值范围： `local`-从本地配置获取 `server`-从用户目录同步和从认证服务器获取
├─ status	启用状态来源	否	string	取值范围： `local`-从本地配置获取 `server`-从用户目录同步和从认证服务器获取
├─ phone	手机号来源	否	string	取值范围： `local`-从本地配置获取 `server`-从用户目录同步和从认证服务器获取
├─ email	邮箱来源	否	string	取值范围： `local`-从本地配置获取 `server`-从用户目录同步和从认证服务器获取
├─ expiredTime	过期时间来源	否	string	取值范围： `local`-从本地配置获取 `server`-从用户目录同步和从认证服务器获取

请求示例

curl --location --request POST 'https://SDPC-IP:4433/api/v3/user/updateByName?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
    "directoryDomain": "custom01339",
    "name": "zhangsan",
    "group": {
        "key": "fullPath",
        "data": "/客服体系/专家中心/零信任专家组"
    },
    "inheritGroup": 1,
    "displayName": "zhangsan",
    "description": "通过openApi v3 创建",
    "status": 0,
    "phone": "13800000000",
    "email": "zhangsan@website.com",
    "expiredTime": "1710745688563",
    "dataSource": {
        "description": "local",
        "email": "local",
        "phone": "local",
        "status": "server",
        "displayName": "server",
        "expiredTime": "server"
    }
}'

返回数据

参数	中文名称	类型	描述
code	响应码	string	`OK` 表示成功，其他表示出错。具体含义请参考错误码定义
data	响应数据	object
msg	描述信息	string
traceId	调用链id	string

响应示例

{
    "code": "OK",
    "data": {},
    "msg": "请求成功",
    "traceId": "00ca70c9adde821f"
}

错误码

点击查看

4.2.2.2 编辑用户-基于名称

4.2.2.2 编辑用户-基于名称

results matching ""

No results matching ""